<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>volatility.plugins.addrspaces.standard.FileAddressSpace : API documentation</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="class">v.p.a.s.FileAddressSpace(<a href="volatility.addrspace.BaseAddressSpace.html">addrspace.BaseAddressSpace</a>) : class documentation</h1>
    <p>
      <span id="part">Part of <a href="volatility.html">volatility</a>.<a href="volatility.plugins.html">plugins</a>.<a href="volatility.plugins.addrspaces.html">addrspaces</a>.<a href="volatility.plugins.addrspaces.standard.html">standard</a></span>
      
      <a href="classIndex.html#volatility.plugins.addrspaces.standard.FileAddressSpace">View In Hierarchy</a>
    </p>
    <div>
      <p>Known subclasses: <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></p>
    </div>
    <div>This is a direct file AS.</p>
<p>For this AS to be instantiated, we need</p>
<ol class="rst-arabic simple">
<li>A valid config.LOCATION (starting with <a class="rst-reference external" href="file://" target="_top">file://</a>)</li>
<li>no one else has picked the AS before us</li>
</ol>
<p>3) base == None (we dont operate on anyone else so we need to be
right at the bottom of the AS stack.)<table class="fieldTable"></table></div>

    
    
    <div id="splitTables">
      <table class="children sortable" id="id1242">
  
  
<tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#__init__">__init__</a></td>
    <td><span>base is the AS we will be stacking on top of, opts are options which we may use.</span></td>
  </tr><tr class="staticmethod">
    
    
    <td>Static Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#register_options">register_options</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#fread">fread</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#read">read</a></td>
    <td><span>Read some data from a certain offset</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#zread">zread</a></td>
    <td><span>Read data from a certain offset padded with where data is not available</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#read_long">read_long</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#get_available_addresses">get_available_addresses</a></td>
    <td><span>Return a generator of address ranges as (offset, size) covered by this AS sorted by offset.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#is_valid_address">is_valid_address</a></td>
    <td><span>Tell us if the address is valid</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#close">close</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#write">write</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.addrspaces.standard.FileAddressSpace.html#__eq__">__eq__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr>
  
</table>
      
        <p>
          Inherited from <a href="volatility.addrspace.BaseAddressSpace.html">BaseAddressSpace</a>:
        </p>
        <table class="children sortable" id="id1243">
  
  
<tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.addrspace.BaseAddressSpace.html#get_config">get_config</a></td>
    <td><span>Returns the config object used by the vm for use in other vms</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.addrspace.BaseAddressSpace.html#is_valid_profile">is_valid_profile</a></td>
    <td><span>Determines whether a selected profile is compatible with this address space</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.addrspace.BaseAddressSpace.html#as_assert">as_assert</a></td>
    <td><span>Duplicate for the assert command (so that optimizations don't disable them)</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.addrspace.BaseAddressSpace.html#__ne__">__ne__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.addrspace.BaseAddressSpace.html#__getstate__">__getstate__</a></td>
    <td><span>Serialise this address space efficiently</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.addrspace.BaseAddressSpace.html#__setstate__">__setstate__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    
    <td>Method</td>
    <td><a href="volatility.addrspace.BaseAddressSpace.html#_set_profile">_set_profile</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    

    <div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self, base, config, layered=False, **kwargs):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#__init__">volatility.addrspace.BaseAddressSpace.__init__</a></div><div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div>base is the AS we will be stacking on top of, opts are
options which we may use.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.register_options">
    
  </a>
  <a name="register_options">
    
  </a>
  <div class="functionHeader">
    @staticmethod<br />
    def
    register_options(config):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#register_options">volatility.addrspace.BaseAddressSpace.register_options</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.fread">
    
  </a>
  <a name="fread">
    
  </a>
  <div class="functionHeader">
    
    def
    fread(self, length):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.read">
    
  </a>
  <a name="read">
    
  </a>
  <div class="functionHeader">
    
    def
    read(self, addr, length):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#read">volatility.addrspace.BaseAddressSpace.read</a></div><div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div>Read some data from a certain offset<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.zread">
    
  </a>
  <a name="zread">
    
  </a>
  <div class="functionHeader">
    
    def
    zread(self, addr, length):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#zread">volatility.addrspace.BaseAddressSpace.zread</a></div><div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div>Read data from a certain offset padded with where data is not available<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.read_long">
    
  </a>
  <a name="read_long">
    
  </a>
  <div class="functionHeader">
    
    def
    read_long(self, addr):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.get_available_addresses">
    
  </a>
  <a name="get_available_addresses">
    
  </a>
  <div class="functionHeader">
    
    def
    get_available_addresses(self):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#get_available_addresses">volatility.addrspace.BaseAddressSpace.get_available_addresses</a></div><div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div>Return a generator of address ranges as (offset, size) covered by this AS sorted by offset.</p>
<p>The address ranges produced must be disjoint (no overlaps) and not be continuous
(there must be a gap between two ranges).<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.is_valid_address">
    
  </a>
  <a name="is_valid_address">
    
  </a>
  <div class="functionHeader">
    
    def
    is_valid_address(self, addr):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#is_valid_address">volatility.addrspace.BaseAddressSpace.is_valid_address</a></div><div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div>Tell us if the address is valid<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.close">
    
  </a>
  <a name="close">
    
  </a>
  <div class="functionHeader">
    
    def
    close(self):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.write">
    
  </a>
  <a name="write">
    
  </a>
  <div class="functionHeader">
    
    def
    write(self, addr, data):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#write">volatility.addrspace.BaseAddressSpace.write</a></div><div class="interfaceinfo">overridden in <a href="volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32.html">volatility.plugins.addrspaces.crash.WindowsCrashDumpSpace32</a>, <a href="volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32.html">volatility.plugins.addrspaces.hibernate.WindowsHiberFileSpace32</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.addrspaces.standard.FileAddressSpace.__eq__">
    
  </a>
  <a name="__eq__">
    
  </a>
  <div class="functionHeader">
    
    def
    __eq__(self, other):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.addrspace.BaseAddressSpace.html#__eq__">volatility.addrspace.BaseAddressSpace.__eq__</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div>
    <address>
      <a href="index.html">API Documentation</a> for Volatility 2.2, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2013-06-24 15:16:10.
    </address>
  </body>
</html>